4.4 Gerar plano de pagamento

Request

Request

mutation AddPaymentPlan {
    addPaymentPlan(
        data: {
            financialOwnerId: 48
            dependentId: 49
            companyId: 1
            costCenterId: 1
            financialIntegrationId: 1
            paymentPlanType: MONTHLY
            billings: [
                { dueDate: "2025-01-15T00:00:00.000Z", value: 100 }
                { dueDate: "2025-02-15T00:00:00.000Z", value: 100 }
            ]
        }
    ) {
        id
    }
}

Params

Parâmetro	Tipo	Descrição
data	AddPaymentPlanDataInput!	Dados de Inclusão de Plano de Pagamento

Objeto AddPaymentPlanDataInput

Campo	Tipo	Descrição
auditData	AuditDataInput	Dados de auditoria do sistema integrado
billings	[AddBillingDataInput!]	Lista de dados para emissão de boletos
companyId	Int!	Id da Empresa
confirmationForOverdue	Boolean	Confirmação para criação do plano de pagamento com um responsável inadimplente
costCenterId	Int	Id do Centro de Custo
costCenterName	String	Id do Nome do Centro de Custo
deductedDiscounts	[Int!]	Descontos Deduzidos
dependentId	Int	Id do Dependente
dependentRefId	String	Id de Referência do Dependente
description	String	Descrição
financialIntegrationId	Int!	Id da Integração Financeira
financialOwnerId	Int	Id do Responsável Financeiro
financialOwnerRefId	String	Id de Referência do Responsável Financeiro
parcelQuantity	Int	Quantidade de Parcelas
paymentPlanType	PaymentPlanType!	Tipo de Plano de Pagamento
punctualDiscounts	[Int!]	Descontos por Pontualidade

Objeto AddBillingDataInput

Campo	Tipo	Descrição
auditData	AuditDataInput	Dados de auditoria do sistema integrado
competenceDate	DateTime	Data de competência
deductedDiscountIds	[Int!]	Ids dos descontos deduzidos
description	String	Descrição
discount	Decimal	Desconto
discountUntil	DateTime	Data limite para aplicação do Desconto
dueDate	DateTime!	Data de vencimento
financialIntegrationId	Int	Id da integração financeira
financialIntegrationRefId	String	Id da referência da integração financeira
notes	String	Anotação
paymentPlanId	Int	Id do Plano de Pagamento
paymentPlanRefId	String	Id da Referência do Plano de Pagamento
paymentType	PaymentType	Tipo de Pagamento
punctualDiscountIds	[Int!]	Ids dos Descontos por Pontualidade
punctualDiscounts	[AddPunctualDiscountDataInput!]	Descontos por Pontualidade
value	Decimal!	Valor

Response

Response

{
    "data": {
        "addPaymentPlan": {
            "id": "fbc2f932-89be-4dba-8c00-bd6b3e820cef"
        }
    }
}

Result

Campo	Tipo	Descrição
addPaymentPlan	AddPaymentPlanResult!	Dados do Resultado da Inclusão de Plano de Pagamento

Objeto AddPaymentPlanResult

Campo	Tipo	Descrição
id	UUID!	Id referência do plano de pagamento